Skip to content

chore: renaming deserialize_document_store_in_init_params_inplace #8379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
davidsbatista wants to merge 5 commits into from
Closed

chore: renaming deserialize_document_store_in_init_params_inplace #8379

davidsbatista wants to merge 5 commits into from

Conversation

@davidsbatista
Copy link
Contributor

@davidsbatista davidsbatista commented Sep 17, 2024 •
edited
Loading

Proposed Changes:

  • renaming the deserialize_document_store_in_init_params_inplaceutil, since it can also work with any other component

How did you test it?

  • ran unit tests locally and manual verification
  • ran CI tests

Checklist

@github-actions github-actions bot added topic:tests type:documentation Improvements on the docs labels Sep 17, 2024
@davidsbatista davidsbatista changed the title initial import chore: renaming deserialize_document_store_in_init_params_inplaceuti, it works with any other component Sep 17, 2024
@coveralls
Copy link
Collaborator

coveralls commented Sep 17, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 12809215757

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 91.292%
Totals Coverage Status
Change from base Build 12794162077: 0.0%
Covered Lines: 8838
Relevant Lines: 9681
💛 - Coveralls

@davidsbatista davidsbatista changed the title chore: renaming deserialize_document_store_in_init_params_inplaceuti, it works with any other component chore: renaming deserialize_document_store_in_init_params_inplace, it works with any other component Sep 17, 2024
@davidsbatista davidsbatista changed the title chore: renaming deserialize_document_store_in_init_params_inplace, it works with any other component chore: renaming deserialize_document_store_in_init_params_inplace Sep 17, 2024
@davidsbatista davidsbatista marked this pull request as ready for review September 17, 2024 17:23
@davidsbatista davidsbatista requested review from a team as code owners September 17, 2024 17:23
@davidsbatista davidsbatista requested review from dfokina, shadeMe and vblagoje and removed request for a team September 17, 2024 17:23
@davidsbatista davidsbatista removed the request for review from shadeMe December 12, 2024 00:01
vblagoje
vblagoje reviewed Jan 16, 2025
View reviewed changes
Copy link
Member

@vblagoje vblagoje left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, let one minor comment to minimize downstream disruption. @anakin87 is also good in spotting problems this change can cause.

haystack/utils/__init__.py
"serialize_type",
"deserialize_type",
"deserialize_document_store_in_init_params_inplace",
"deserialize_component_in_init_params_inplace",
Copy link
Member

@vblagoje vblagoje Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can create an alias above from here:

deserialize_document_store_in_init_params_inplace = deserialize_component_in_init_params_inplace

and then export both to minimize havoc this will create in downstream deps

@davidsbatista
Copy link
Contributor Author

davidsbatista commented Jan 16, 2025

NOTE: this is an old PR, I just updated it to see if it has any conflicts - note 100% sure if it still make sense, also OK if we just close it

anakin87
anakin87 requested changes Jan 24, 2025
View reviewed changes
Copy link
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this utility function can work also for components, I would be happy to rename it.

But a Document Store is not a component, so I would choose a clearer name:
deserialize_document_store_or_component_in_init_params_inplace is very long, but I would opt for something similar.

If this function can work with components, let's also add a test to verify/show this behavior.

@davidsbatista
Copy link
Contributor Author

davidsbatista commented Feb 4, 2025

I will close this for now, we can look into it later if necessary

@davidsbatista davidsbatista deleted the refactor-deserialize-util branch April 2, 2025 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vblagoje vblagoje vblagoje left review comments

@anakin87 anakin87 anakin87 requested changes

@dfokina dfokina Awaiting requested review from dfokina dfokina was automatically assigned from deepset-ai/documentation

Assignees

No one assigned

Labels

topic:tests type:documentation Improvements on the docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@davidsbatista @coveralls @vblagoje @anakin87